VisitUpdate

Description

A VisitUpdate event type is generated when there are changes to patient or registration information related to a visit. This event type is typically triggered when there are updates or modifications to a patient's demographic information, such as name, date of birth, address, contact information, or other registration details associated with a visit.

API endpoints for Visit Update

Sync REST API Endpoint to call the API: https://{base_url}/api/v1/patient-admin/visit-update.

Async REST API Endpoint to call the API: https://{base_url}/api/v1/endpoint.

Data Model JSON for VisitUpdate

VisitUpdate - Sample Payload

{
   "Meta": {
      "DataModel": "PatientAdmin",
      "EventType": "VisitUpdate",
      "EventDateTime": "2022-08-16T14:21:20.733Z",
      "Test": true,
      "Source": {
         "ID": "03367b90-05c4-4f74-a8b4-c6bad96c3f3d",
         "Name": "EHR Bridge Dev Tools"
      },
      "Destinations": [
         {
            "ID": "e33cb9d6-5dfd-4ddb-af17-815d3373b859 ",
            "Name": "Destinations EMR"
         }
      ],
      "Logs": [
         {
            "ID": "6f74444b-1718-4d28-b593-2b890ae661a1",
            "AttemptID": "4b573c19-c1ea-483b-a987-71d691f03bea"
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "FacilityCode": null
   },
   "Patient": {
      "Identifiers": [
         {
            "ID": "0000000001",
            "IDType": "MR"
         },
         {
            "ID": "4392ef03-77c1-4dc3-8049-3f333a8e2943",
            "IDType": "EHRID"
         },
         {
            "ID": "b704b986-6d8e-411e-9d29-bd6d9e71729d",
            "IDType": "NIST"
         }
      ],
      "Demographics": {
         "FirstName": "John",
         "MiddleName": "Henry",
         "LastName": "Franklin",
         "DOB": "2008-01-06",
         "SSN": "101-01-0001",
         "Sex": "Male",
         "Race": "White",
         "IsHispanic": null,
         "Religion": null,
         "MaritalStatus": "Single",
         "IsDeceased": null,
         "DeathDateTime": null,
         "PhoneNumber": {
            "Home": "+18088675301",
            "Office": null,
            "Mobile": null
         },
         "EmailAddresses": [],
         "Language": "en",
         "Citizenship": [],
         "Address": {
            "StreetAddress": "4762 High Street",
            "City": "San Jose"",
            "State": "CA",
            "ZIP": "53566",
            "County": "Santa Clara",
            "Country": "USA"
         }
      },
      "Notes": [],
      "Contacts": [
         {
            "FirstName": "Sara",
            "MiddleName": null,
            "LastName": "Franklin",
            "Address": {
               "StreetAddress": "4762 High Street",
               "City": "San Jose"",
               "State": "CA",
               "ZIP": "53566",
               "County": "Santa Clara",
               "Country": "USA"
            },
            "PhoneNumber": {
               "Home": "+18088675303",
               "Office": "+17077543758",
               "Mobile": "+19189368865"
            },
            "RelationToPatient": "Mother",
            "EmailAddresses": [
               "sara.f@test.net"
            ],
            "Roles": [
               "Emergency Contact"
            ]
         }
      ],
      "Diagnoses": [
         {
            "Code": "R07.0",
            "Codeset": "ICD-10",
            "Name": "Throat infection",
            "Type": null,
            "DocumentedDateTime": null
         }
      ],
      "Allergies": [
         {
            "Code": "7982",
            "Codeset": "RxNorm",
            "Name": "Penicillin_II",
            "Type": {
               "Code": null,
               "Codeset": null,
               "Name": null
            },
            "OnsetDateTime": null,
            "Reaction": [
               {
                  "Code": "28926001",
                  "Codeset": "SNOMED CT",
                  "Name": "Rash"
               },
               {
                  "Code": "247472004",
                  "Codeset": "SNOMED CT",
                  "Name": "Hives"
               }
            ],
            "Severity": {
               "Code": null,
               "Codeset": null,
               "Name": null
            },
            "Status": null
         }
      ],
      "PCP": {
         "NPI": "4356789876",
         "ID": "4356789876",
         "IDType": "NPI",
         "FirstName": "Davis",
         "LastName": "Wilson",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "123 Main St.",
            "City": "San Jose"",
            "State": "CA",
            "ZIP": "53703",
            "County": "Santa Clara",
            "Country": "USA"
         },
         "EmailAddresses": [],
         "PhoneNumber": {
            "Office": "+16085551234"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         }
      }
   },
   "Visit": {
      "VisitNumber": "1234",
      "AccountNumber": null,
      "PatientClass": "Inpatient",
      "VisitDateTime": "2022-08-16T14:21:21.520Z",
      "DischargeDateTime": null,
      "Duration": 30,
      "Reason": "Check up",
      "Instructions": [],
      "Balance": null,
      "DiagnosisRelatedGroup": null,
      "DiagnosisRelatedGroupType": null,
      "AttendingProvider": {
         "ID": "4356789876",
         "IDType": "NPI",
         "FirstName": "Davis",
         "LastName": "Wilson",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "123 Main St.",
            "City": "San Jose"",
            "State": "CA",
            "ZIP": "53703",
            "County": "Santa Clara",
            "Country": "USA"
         },
         "EmailAddresses": [],
         "PhoneNumber": {
            "Office": "+16085551234"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         }
      },
      "ConsultingProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "EmailAddresses": [],
         "PhoneNumber": {
            "Office": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         }
      },
      "ReferringProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "EmailAddresses": [],
         "PhoneNumber": {
            "Office": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         }
      },
      "AdmittingProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "EmailAddresses": [],
         "PhoneNumber": {
            "Office": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         }
      },
      "AdditionalStaff": [],
      "Location": {
         "Type": "Inpatient",
         "Facility": "MGM Hospital",
         "Department": "3N",
         "Room": "136",
         "Bed": "B",
         "Address": {
            "StreetAddress": "78 High Ln",
            "City": "San Jose"",
            "State": "CA",
            "ZIP": "53719",
            "County": "Santa Clara",
            "Country": "USA"
         }
      },
      "Guarantor": {
         "Number": "10001910",
         "FirstName": "Kent",
         "MiddleName": null,
         "LastName": "Allen",
         "SSN": null,
         "DOB": null,
         "Sex": null,
         "Spouse": {
            "FirstName": "Gracy",
            "LastName": "Allen"
         },
         "Address": {
            "StreetAddress": "4762 Austin Street",
            "City": "San Jose"",
            "State": "CA",
            "ZIP": "53566",
            "County": "Santa Clara",
            "Country": "USA"
         },
         "PhoneNumber": {
            "Home": null,
            "Business": null,
            "Mobile": null
         },
         "EmailAddresses": [],
         "Type": null,
         "RelationToPatient": "Father",
         "Employer": {
            "Name": "Digitech Labs",
            "Address": {
               "StreetAddress": "1456 Old Ring Road",
               "City": "San Jose"",
               "State": "CA",
               "ZIP": "53719",
               "County": "Santa Clara",
               "Country": "USA"
            },
            "PhoneNumber": "+18083451121"
         }
      },
      "Insurances": [
         {
            "Plan": {
               "ID": "31572",
               "IDType": "Payor ID",
               "Name": "HMO Plan",
               "Type": null
            },
            "MemberNumber": null,
            "Company": {
               "ID": "60054",
               "IDType": null,
               "Name": "aetna (60054 0131)",
               "Address": {
                  "StreetAddress": "PO Box 14080",
                  "City": "San Jose"",
                  "State": "CA",
                  "ZIP": "40512-4079",
                  "County": "Santa Clara",
                  "Country": "USA"
               },
               "PhoneNumber": "+18089541123"
            },
            "GroupNumber": "847025-024-0009",
            "GroupName": "Digitech Labs",
            "EffectiveDate": "2015-01-01",
            "ExpirationDate": "2020-12-31",
            "PolicyNumber": "9140860055",
            "Priority": null,
            "AgreementType": null,
            "CoverageType": null,
            "Insured": {
               "Identifiers": [],
               "LastName": null,
               "MiddleName": null,
               "FirstName": null,
               "SSN": null,
               "Relationship": null,
               "DOB": null,
               "Sex": null,
               "Address": {
                  "StreetAddress": null,
                  "City": null,
                  "State": null,
                  "ZIP": null,
                  "County": null,
                  "Country": null
               }
            }
         }
      ]
   }
}